blob: 0c897df6a71ddb5e7f4e960300c2b336ede5aab2 [file] [log] [blame]
Junio C Hamanof7c042d2008-06-06 22:50:531git(1)
Junio C Hamano1a4e8412005-12-27 08:17:232======
3
4NAME
5----
6git - the stupid content tracker
7
8
9SYNOPSIS
10--------
Junio C Hamano6b2cee12006-08-26 08:43:3111[verse]
Junio C Hamanod2179ef2010-10-22 04:12:1712'git' [--version] [--exec-path[=<path>]] [--html-path]
Junio C Hamano3d23a0a2009-10-19 08:04:3013 [-p|--paginate|--no-pager] [--no-replace-objects]
Junio C Hamanod2179ef2010-10-22 04:12:1714 [--bare] [--git-dir=<path>] [--work-tree=<path>]
15 [-c <name>=<value>]
16 [--help] <command> [<args>]
Junio C Hamano1a4e8412005-12-27 08:17:2317
18DESCRIPTION
19-----------
Junio C Hamanoe27fb932006-04-03 05:34:1020Git is a fast, scalable, distributed revision control system with an
21unusually rich command set that provides both high-level operations
22and full access to internals.
23
Junio C Hamanofce7c7e2008-07-02 03:06:3824See linkgit:gittutorial[7] to get started, then see
Junio C Hamanoe27fb932006-04-03 05:34:1025link:everyday.html[Everyday Git] for a useful minimum set of commands, and
26"man git-commandname" for documentation of each command. CVS users may
Junio C Hamanofce7c7e2008-07-02 03:06:3827also want to read linkgit:gitcvs-migration[7]. See
28the link:user-manual.html[Git User's Manual] for a more in-depth
Junio C Hamano3d30fd52007-05-08 00:32:5329introduction.
Junio C Hamano1a4e8412005-12-27 08:17:2330
Junio C Hamanod2179ef2010-10-22 04:12:1731The '<command>' is either a name of a Git command (see below) or an alias
Junio C Hamano35738e82008-01-07 07:55:4632as defined in the configuration file (see linkgit:git-config[1]).
Junio C Hamano33db4372006-06-07 19:51:4533
Junio C Hamanob63afff2007-05-01 03:05:5534Formatted and hyperlinked version of the latest git
35documentation can be viewed at
36`http://www.kernel.org/pub/software/scm/git/docs/`.
37
Junio C Hamano9d52e572007-02-13 23:48:2038ifdef::stalenotes[]
39[NOTE]
40============
Junio C Hamano9d52e572007-02-13 23:48:2041
Junio C Hamanoa9b8d242007-05-19 04:51:5542You are reading the documentation for the latest (possibly
43unreleased) version of git, that is available from 'master'
44branch of the `git.git` repository.
45Documentation for older releases are available here:
Junio C Hamano2fc92602007-03-29 01:09:4646
Junio C Hamanod2179ef2010-10-22 04:12:1747* link:v1.7.3.2/git.html[documentation for release 1.7.3.2]
Junio C Hamanoac752fa2010-09-19 00:01:0048
49* release notes for
Junio C Hamanod2179ef2010-10-22 04:12:1750 link:RelNotes/1.7.3.2.txt[1.7.3.2],
Junio C Hamano3b4609d2010-09-30 00:04:3451 link:RelNotes/1.7.3.1.txt[1.7.3.1],
Junio C Hamanoac752fa2010-09-19 00:01:0052 link:RelNotes/1.7.3.txt[1.7.3].
53
Junio C Hamano2db3e752010-09-03 21:33:0654* link:v1.7.2.3/git.html[documentation for release 1.7.2.3]
Junio C Hamano08acb732010-07-21 21:58:3355
56* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:1757 link:RelNotes/1.7.2.3.txt[1.7.2.3],
58 link:RelNotes/1.7.2.2.txt[1.7.2.2],
59 link:RelNotes/1.7.2.1.txt[1.7.2.1],
60 link:RelNotes/1.7.2.txt[1.7.2].
Junio C Hamano08acb732010-07-21 21:58:3361
Junio C Hamano8ac9d8a2010-07-28 17:27:2562* link:v1.7.1.2/git.html[documentation for release 1.7.1.2]
Junio C Hamanofc5d7352010-04-24 02:59:1163
64* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:1765 link:RelNotes/1.7.1.2.txt[1.7.1.2],
66 link:RelNotes/1.7.1.1.txt[1.7.1.1],
67 link:RelNotes/1.7.1.txt[1.7.1].
Junio C Hamanofc5d7352010-04-24 02:59:1168
Junio C Hamano8ac9d8a2010-07-28 17:27:2569* link:v1.7.0.7/git.html[documentation for release 1.7.0.7]
Junio C Hamanodca34822010-02-13 01:02:5270
71* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:1772 link:RelNotes/1.7.0.7.txt[1.7.0.7],
73 link:RelNotes/1.7.0.6.txt[1.7.0.6],
74 link:RelNotes/1.7.0.5.txt[1.7.0.5],
75 link:RelNotes/1.7.0.4.txt[1.7.0.4],
76 link:RelNotes/1.7.0.3.txt[1.7.0.3],
77 link:RelNotes/1.7.0.2.txt[1.7.0.2],
78 link:RelNotes/1.7.0.1.txt[1.7.0.1],
79 link:RelNotes/1.7.0.txt[1.7.0].
Junio C Hamanodca34822010-02-13 01:02:5280
Junio C Hamanoe7c7be32010-02-10 23:26:4881* link:v1.6.6.2/git.html[documentation for release 1.6.6.2]
Junio C Hamanof3a01ab2009-12-24 00:30:3482
83* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:1784 link:RelNotes/1.6.6.2.txt[1.6.6.2],
85 link:RelNotes/1.6.6.1.txt[1.6.6.1],
86 link:RelNotes/1.6.6.txt[1.6.6].
Junio C Hamanof3a01ab2009-12-24 00:30:3487
Junio C Hamanoa9701f02010-01-21 00:42:1688* link:v1.6.5.8/git.html[documentation for release 1.6.5.8]
Junio C Hamano77e01e32009-10-11 01:57:3489
90* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:1791 link:RelNotes/1.6.5.8.txt[1.6.5.8],
92 link:RelNotes/1.6.5.7.txt[1.6.5.7],
93 link:RelNotes/1.6.5.6.txt[1.6.5.6],
94 link:RelNotes/1.6.5.5.txt[1.6.5.5],
95 link:RelNotes/1.6.5.4.txt[1.6.5.4],
96 link:RelNotes/1.6.5.3.txt[1.6.5.3],
97 link:RelNotes/1.6.5.2.txt[1.6.5.2],
98 link:RelNotes/1.6.5.1.txt[1.6.5.1],
99 link:RelNotes/1.6.5.txt[1.6.5].
Junio C Hamano77e01e32009-10-11 01:57:34100
Junio C Hamanofb44f812009-09-17 00:40:17101* link:v1.6.4.4/git.html[documentation for release 1.6.4.4]
Junio C Hamano3bd4ce32009-06-04 07:18:09102
103* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17104 link:RelNotes/1.6.4.4.txt[1.6.4.4],
105 link:RelNotes/1.6.4.3.txt[1.6.4.3],
106 link:RelNotes/1.6.4.2.txt[1.6.4.2],
107 link:RelNotes/1.6.4.1.txt[1.6.4.1],
108 link:RelNotes/1.6.4.txt[1.6.4].
Junio C Hamano543f8d62009-07-29 08:35:21109
110* link:v1.6.3.4/git.html[documentation for release 1.6.3.4]
111
112* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17113 link:RelNotes/1.6.3.4.txt[1.6.3.4],
114 link:RelNotes/1.6.3.3.txt[1.6.3.3],
115 link:RelNotes/1.6.3.2.txt[1.6.3.2],
116 link:RelNotes/1.6.3.1.txt[1.6.3.1],
117 link:RelNotes/1.6.3.txt[1.6.3].
Junio C Hamanoa9eca4e2009-03-04 08:29:59118
119* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17120 link:RelNotes/1.6.2.5.txt[1.6.2.5],
121 link:RelNotes/1.6.2.4.txt[1.6.2.4],
122 link:RelNotes/1.6.2.3.txt[1.6.2.3],
123 link:RelNotes/1.6.2.2.txt[1.6.2.2],
124 link:RelNotes/1.6.2.1.txt[1.6.2.1],
125 link:RelNotes/1.6.2.txt[1.6.2].
Junio C Hamanoa9eca4e2009-03-04 08:29:59126
Junio C Hamanoe5bf6c12009-02-07 21:43:10127* link:v1.6.1.3/git.html[documentation for release 1.6.1.3]
Junio C Hamano13016de2008-12-25 05:46:57128
129* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17130 link:RelNotes/1.6.1.3.txt[1.6.1.3],
131 link:RelNotes/1.6.1.2.txt[1.6.1.2],
132 link:RelNotes/1.6.1.1.txt[1.6.1.1],
133 link:RelNotes/1.6.1.txt[1.6.1].
Junio C Hamano13016de2008-12-25 05:46:57134
Junio C Hamano54bf1e22008-12-20 06:30:11135* link:v1.6.0.6/git.html[documentation for release 1.6.0.6]
Junio C Hamanoc6e59502008-08-17 21:05:51136
137* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17138 link:RelNotes/1.6.0.6.txt[1.6.0.6],
139 link:RelNotes/1.6.0.5.txt[1.6.0.5],
140 link:RelNotes/1.6.0.4.txt[1.6.0.4],
141 link:RelNotes/1.6.0.3.txt[1.6.0.3],
142 link:RelNotes/1.6.0.2.txt[1.6.0.2],
143 link:RelNotes/1.6.0.1.txt[1.6.0.1],
144 link:RelNotes/1.6.0.txt[1.6.0].
Junio C Hamanoc6e59502008-08-17 21:05:51145
Junio C Hamano54bf1e22008-12-20 06:30:11146* link:v1.5.6.6/git.html[documentation for release 1.5.6.6]
Junio C Hamano11fe55c2008-06-18 23:14:56147
148* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17149 link:RelNotes/1.5.6.6.txt[1.5.6.6],
150 link:RelNotes/1.5.6.5.txt[1.5.6.5],
151 link:RelNotes/1.5.6.4.txt[1.5.6.4],
152 link:RelNotes/1.5.6.3.txt[1.5.6.3],
153 link:RelNotes/1.5.6.2.txt[1.5.6.2],
154 link:RelNotes/1.5.6.1.txt[1.5.6.1],
155 link:RelNotes/1.5.6.txt[1.5.6].
Junio C Hamano11fe55c2008-06-18 23:14:56156
Junio C Hamano54bf1e22008-12-20 06:30:11157* link:v1.5.5.6/git.html[documentation for release 1.5.5.6]
Junio C Hamano0d0679d2008-04-08 06:15:46158
159* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17160 link:RelNotes/1.5.5.6.txt[1.5.5.6],
161 link:RelNotes/1.5.5.5.txt[1.5.5.5],
162 link:RelNotes/1.5.5.4.txt[1.5.5.4],
163 link:RelNotes/1.5.5.3.txt[1.5.5.3],
164 link:RelNotes/1.5.5.2.txt[1.5.5.2],
165 link:RelNotes/1.5.5.1.txt[1.5.5.1],
166 link:RelNotes/1.5.5.txt[1.5.5].
Junio C Hamano0d0679d2008-04-08 06:15:46167
Junio C Hamano54bf1e22008-12-20 06:30:11168* link:v1.5.4.7/git.html[documentation for release 1.5.4.7]
Junio C Hamano7b9b4262008-02-02 06:48:39169
170* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17171 link:RelNotes/1.5.4.7.txt[1.5.4.7],
172 link:RelNotes/1.5.4.6.txt[1.5.4.6],
173 link:RelNotes/1.5.4.5.txt[1.5.4.5],
174 link:RelNotes/1.5.4.4.txt[1.5.4.4],
175 link:RelNotes/1.5.4.3.txt[1.5.4.3],
176 link:RelNotes/1.5.4.2.txt[1.5.4.2],
177 link:RelNotes/1.5.4.1.txt[1.5.4.1],
178 link:RelNotes/1.5.4.txt[1.5.4].
Junio C Hamano7b9b4262008-02-02 06:48:39179
Junio C Hamano4e272312008-01-08 09:13:21180* link:v1.5.3.8/git.html[documentation for release 1.5.3.8]
Junio C Hamanoa75069c2007-09-04 01:19:24181
182* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17183 link:RelNotes/1.5.3.8.txt[1.5.3.8],
184 link:RelNotes/1.5.3.7.txt[1.5.3.7],
185 link:RelNotes/1.5.3.6.txt[1.5.3.6],
186 link:RelNotes/1.5.3.5.txt[1.5.3.5],
187 link:RelNotes/1.5.3.4.txt[1.5.3.4],
188 link:RelNotes/1.5.3.3.txt[1.5.3.3],
189 link:RelNotes/1.5.3.2.txt[1.5.3.2],
190 link:RelNotes/1.5.3.1.txt[1.5.3.1],
191 link:RelNotes/1.5.3.txt[1.5.3].
Junio C Hamano75485c82007-05-19 04:20:33192
Junio C Hamano9eb57532008-06-26 06:33:46193* link:v1.5.2.5/git.html[documentation for release 1.5.2.5]
194
Junio C Hamanoed7f4f62007-05-20 09:09:09195* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17196 link:RelNotes/1.5.2.5.txt[1.5.2.5],
197 link:RelNotes/1.5.2.4.txt[1.5.2.4],
198 link:RelNotes/1.5.2.3.txt[1.5.2.3],
199 link:RelNotes/1.5.2.2.txt[1.5.2.2],
200 link:RelNotes/1.5.2.1.txt[1.5.2.1],
201 link:RelNotes/1.5.2.txt[1.5.2].
Junio C Hamanoed7f4f62007-05-20 09:09:09202
203* link:v1.5.1.6/git.html[documentation for release 1.5.1.6]
204
205* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17206 link:RelNotes/1.5.1.6.txt[1.5.1.6],
207 link:RelNotes/1.5.1.5.txt[1.5.1.5],
208 link:RelNotes/1.5.1.4.txt[1.5.1.4],
209 link:RelNotes/1.5.1.3.txt[1.5.1.3],
210 link:RelNotes/1.5.1.2.txt[1.5.1.2],
211 link:RelNotes/1.5.1.1.txt[1.5.1.1],
212 link:RelNotes/1.5.1.txt[1.5.1].
Junio C Hamano91d44c52007-05-09 07:16:07213
Junio C Hamanoa9b8d242007-05-19 04:51:55214* link:v1.5.0.7/git.html[documentation for release 1.5.0.7]
Junio C Hamano91d44c52007-05-09 07:16:07215
Junio C Hamanoed7f4f62007-05-20 09:09:09216* release notes for
Junio C Hamano05d16ca2010-09-10 21:57:17217 link:RelNotes/1.5.0.7.txt[1.5.0.7],
218 link:RelNotes/1.5.0.6.txt[1.5.0.6],
219 link:RelNotes/1.5.0.5.txt[1.5.0.5],
220 link:RelNotes/1.5.0.3.txt[1.5.0.3],
221 link:RelNotes/1.5.0.2.txt[1.5.0.2],
222 link:RelNotes/1.5.0.1.txt[1.5.0.1],
223 link:RelNotes/1.5.0.txt[1.5.0].
Junio C Hamanoe90436a2007-04-22 07:22:13224
Junio C Hamanoa9b8d242007-05-19 04:51:55225* documentation for release link:v1.4.4.4/git.html[1.4.4.4],
226 link:v1.3.3/git.html[1.3.3],
227 link:v1.2.6/git.html[1.2.6],
228 link:v1.0.13/git.html[1.0.13].
Junio C Hamano9d52e572007-02-13 23:48:20229
230============
231
232endif::stalenotes[]
233
Junio C Hamano1a4e8412005-12-27 08:17:23234OPTIONS
235-------
236--version::
Junio C Hamano01078922006-03-10 00:31:47237Prints the git suite version that the 'git' program came from.
Junio C Hamano1a4e8412005-12-27 08:17:23238
239--help::
Junio C Hamano01078922006-03-10 00:31:47240Prints the synopsis and a list of the most commonly used
Junio C Hamano58256872007-12-04 08:31:13241commands. If the option '--all' or '-a' is given then all
242available commands are printed. If a git command is named this
243option will bring up the manual page for that command.
Junio C Hamano0c0da5f2007-12-13 02:45:30244+
245Other options are available to control how the manual page is
Junio C Hamano35738e82008-01-07 07:55:46246displayed. See linkgit:git-help[1] for more information,
Junio C Hamanoba4b9282008-07-06 05:20:31247because `git --help ...` is converted internally into `git
248help ...`.
Junio C Hamano1a4e8412005-12-27 08:17:23249
Junio C Hamanocc7636a2010-05-21 14:57:53250-c <name>=<value>::
251Pass a configuration parameter to the command. The value
252given will override values from configuration files.
253The <name> is expected in the same format as listed by
254'git config' (subkeys separated by dots).
255
Junio C Hamanod2179ef2010-10-22 04:12:17256--exec-path[=<path>]::
Junio C Hamano01078922006-03-10 00:31:47257Path to wherever your core git programs are installed.
Junio C Hamano1a4e8412005-12-27 08:17:23258This can also be controlled by setting the GIT_EXEC_PATH
Junio C Hamanoba4b9282008-07-06 05:20:31259environment variable. If no path is given, 'git' will print
Junio C Hamano1a4e8412005-12-27 08:17:23260the current setting and then exit.
261
Junio C Hamanob4a9ede2009-04-08 07:36:32262--html-path::
263Print the path to wherever your git HTML documentation is installed
264and exit.
265
Junio C Hamanoeb415992008-06-08 22:49:47266-p::
267--paginate::
Junio C Hamano4aa0bcc2010-03-03 05:13:12268Pipe all output into 'less' (or if set, $PAGER) if standard
269output is a terminal. This overrides the `pager.<cmd>`
270configuration options (see the "Configuration Mechanism" section
271below).
Junio C Hamanof870ef82006-07-29 09:10:13272
Junio C Hamanocae86272007-08-21 02:20:49273--no-pager::
274Do not pipe git output into a pager.
275
Junio C Hamanof870ef82006-07-29 09:10:13276--git-dir=<path>::
277Set the path to the repository. This can also be controlled by
Junio C Hamano7d575a52008-04-30 08:45:27278setting the GIT_DIR environment variable. It can be an absolute
279path or relative path to current working directory.
Junio C Hamanof870ef82006-07-29 09:10:13280
Junio C Hamanod526ba92007-07-02 00:17:42281--work-tree=<path>::
282Set the path to the working tree. The value will not be
283used in combination with repositories found automatically in
284a .git directory (i.e. $GIT_DIR is not set).
285This can also be controlled by setting the GIT_WORK_TREE
286environment variable and the core.worktree configuration
Junio C Hamano7d575a52008-04-30 08:45:27287variable. It can be an absolute path or relative path to
288the directory specified by --git-dir or GIT_DIR.
289Note: If --git-dir or GIT_DIR are specified but none of
290--work-tree, GIT_WORK_TREE and core.worktree is specified,
291the current working directory is regarded as the top directory
292of your working tree.
Junio C Hamanod526ba92007-07-02 00:17:42293
Junio C Hamanof870ef82006-07-29 09:10:13294--bare::
Junio C Hamanoc435b1c2007-08-28 06:25:35295Treat the repository as a bare repository. If GIT_DIR
296environment is not set, it is set to the current working
297directory.
298
Junio C Hamano3d23a0a2009-10-19 08:04:30299--no-replace-objects::
300Do not use replacement refs to replace git objects. See
301linkgit:git-replace[1] for more information.
302
Junio C Hamano1a4e8412005-12-27 08:17:23303
Junio C Hamanoe27fb932006-04-03 05:34:10304FURTHER DOCUMENTATION
305---------------------
Junio C Hamano1a4e8412005-12-27 08:17:23306
Junio C Hamanoe27fb932006-04-03 05:34:10307See the references above to get started using git. The following is
308probably more detail than necessary for a first-time user.
Junio C Hamano1a4e8412005-12-27 08:17:23309
Junio C Hamano597ffcf2007-09-17 17:33:15310The link:user-manual.html#git-concepts[git concepts chapter of the
Junio C Hamanofce7c7e2008-07-02 03:06:38311user-manual] and linkgit:gitcore-tutorial[7] both provide
Junio C Hamano597ffcf2007-09-17 17:33:15312introductions to the underlying git architecture.
Junio C Hamano1a4e8412005-12-27 08:17:23313
Junio C Hamano804b5212009-06-07 16:05:03314See linkgit:gitworkflows[7] for an overview of recommended workflows.
315
Junio C Hamanoe27fb932006-04-03 05:34:10316See also the link:howto-index.html[howto] documents for some useful
317examples.
Junio C Hamano1a4e8412005-12-27 08:17:23318
Junio C Hamanofce7c7e2008-07-02 03:06:38319The internals are documented in the
320link:technical/api-index.html[GIT API documentation].
Junio C Hamano3dac5042007-12-15 08:40:54321
Junio C Hamanoe27fb932006-04-03 05:34:10322GIT COMMANDS
323------------
Junio C Hamano1a4e8412005-12-27 08:17:23324
Junio C Hamanoe27fb932006-04-03 05:34:10325We divide git into high level ("porcelain") commands and low level
326("plumbing") commands.
Junio C Hamano1a4e8412005-12-27 08:17:23327
Junio C Hamanob19b4f02006-10-29 20:47:22328High-level commands (porcelain)
329-------------------------------
330
331We separate the porcelain commands into the main commands and some
332ancillary user utilities.
333
334Main porcelain commands
335~~~~~~~~~~~~~~~~~~~~~~~
336
Junio C Hamano7c73c662007-01-19 00:37:50337include::cmds-mainporcelain.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22338
339Ancillary Commands
340~~~~~~~~~~~~~~~~~~
341Manipulators:
342
Junio C Hamano7c73c662007-01-19 00:37:50343include::cmds-ancillarymanipulators.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22344
345Interrogators:
346
Junio C Hamano7c73c662007-01-19 00:37:50347include::cmds-ancillaryinterrogators.txt[]
Junio C Hamanob19b4f02006-10-29 20:47:22348
Junio C Hamano4ad294b2007-01-20 02:22:50349
350Interacting with Others
351~~~~~~~~~~~~~~~~~~~~~~~
352
353These commands are to interact with foreign SCM and with other
354people via patch over e-mail.
355
356include::cmds-foreignscminterface.txt[]
357
358
Junio C Hamanoe27fb932006-04-03 05:34:10359Low-level commands (plumbing)
360-----------------------------
Junio C Hamano1a4e8412005-12-27 08:17:23361
Junio C Hamanoe27fb932006-04-03 05:34:10362Although git includes its
363own porcelain layer, its low-level commands are sufficient to support
364development of alternative porcelains. Developers of such porcelains
Junio C Hamano35738e82008-01-07 07:55:46365might start by reading about linkgit:git-update-index[1] and
366linkgit:git-read-tree[1].
Junio C Hamano1a4e8412005-12-27 08:17:23367
Junio C Hamano4ad294b2007-01-20 02:22:50368The interface (input, output, set of options and the semantics)
369to these low-level commands are meant to be a lot more stable
370than Porcelain level commands, because these commands are
371primarily for scripted use. The interface to Porcelain commands
372on the other hand are subject to change in order to improve the
373end user experience.
374
375The following description divides
376the low-level commands into commands that manipulate objects (in
Junio C Hamanoe27fb932006-04-03 05:34:10377the repository, index, and working tree), commands that interrogate and
378compare objects, and commands that move objects and references between
379repositories.
Junio C Hamano1a4e8412005-12-27 08:17:23380
Junio C Hamano4ad294b2007-01-20 02:22:50381
Junio C Hamano1a4e8412005-12-27 08:17:23382Manipulation commands
383~~~~~~~~~~~~~~~~~~~~~
Junio C Hamano1a4e8412005-12-27 08:17:23384
Junio C Hamano7c73c662007-01-19 00:37:50385include::cmds-plumbingmanipulators.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23386
387
388Interrogation commands
389~~~~~~~~~~~~~~~~~~~~~~
390
Junio C Hamano7c73c662007-01-19 00:37:50391include::cmds-plumbinginterrogators.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23392
393In general, the interrogate commands do not touch the files in
394the working tree.
395
396
397Synching repositories
398~~~~~~~~~~~~~~~~~~~~~
399
Junio C Hamano7c73c662007-01-19 00:37:50400include::cmds-synchingrepositories.txt[]
Junio C Hamano1a4e8412005-12-27 08:17:23401
Junio C Hamano27a128b2009-08-13 01:23:00402The following are helper commands used by the above; end users
Junio C Hamano4ad294b2007-01-20 02:22:50403typically do not use them directly.
404
405include::cmds-synchelpers.txt[]
406
407
408Internal helper commands
409~~~~~~~~~~~~~~~~~~~~~~~~
410
411These are internal helper commands used by other commands; end
412users typically do not use them directly.
413
414include::cmds-purehelpers.txt[]
415
Junio C Hamano1a4e8412005-12-27 08:17:23416
Junio C Hamano1a4e8412005-12-27 08:17:23417Configuration Mechanism
418-----------------------
419
420Starting from 0.99.9 (actually mid 0.99.8.GIT), `.git/config` file
421is used to hold per-repository configuration options. It is a
Junio C Hamano51c2ab02006-07-09 20:38:54422simple text file modeled after `.ini` format familiar to some
Junio C Hamano1a4e8412005-12-27 08:17:23423people. Here is an example:
424
425------------
426#
427# A '#' or ';' character indicates a comment.
428#
429
430; core variables
431[core]
432; Don't trust file modes
433filemode = false
434
435; user identity
436[user]
437name = "Junio C Hamano"
438email = "junkio@twinsun.com"
439
440------------
441
442Various commands read from the configuration file and adjust
Junio C Hamano4aa0bcc2010-03-03 05:13:12443their operation accordingly. See linkgit:git-config[1] for a
444list.
Junio C Hamano1a4e8412005-12-27 08:17:23445
446
447Identifier Terminology
448----------------------
449<object>::
450Indicates the object name for any type of object.
451
452<blob>::
453Indicates a blob object name.
454
455<tree>::
456Indicates a tree object name.
457
458<commit>::
459Indicates a commit object name.
460
461<tree-ish>::
462Indicates a tree, commit or tag object name. A
463command that takes a <tree-ish> argument ultimately wants to
464operate on a <tree> object but automatically dereferences
465<commit> and <tag> objects that point at a <tree>.
466
Junio C Hamano60f8aa82007-03-06 09:58:26467<commit-ish>::
468Indicates a commit or tag object name. A
469command that takes a <commit-ish> argument ultimately wants to
470operate on a <commit> object but automatically dereferences
471<tag> objects that point at a <commit>.
472
Junio C Hamano1a4e8412005-12-27 08:17:23473<type>::
474Indicates that an object type is required.
475Currently one of: `blob`, `tree`, `commit`, or `tag`.
476
477<file>::
478Indicates a filename - almost always relative to the
479root of the tree structure `GIT_INDEX_FILE` describes.
480
481Symbolic Identifiers
482--------------------
483Any git command accepting any <object> can also use the following
484symbolic notation:
485
486HEAD::
487indicates the head of the current branch (i.e. the
488contents of `$GIT_DIR/HEAD`).
489
490<tag>::
491a valid tag 'name'
492(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
493
494<head>::
495a valid head 'name'
496(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
497
Junio C Hamanoff4b4312006-10-25 22:55:31498For a more complete list of ways to spell object names, see
Junio C Hamanoc27b7332010-10-14 04:37:28499"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
Junio C Hamanoff4b4312006-10-25 22:55:31500
Junio C Hamano1a4e8412005-12-27 08:17:23501
502File/Directory Structure
503------------------------
504
Junio C Hamanofce7c7e2008-07-02 03:06:38505Please see the linkgit:gitrepository-layout[5] document.
Junio C Hamano1a4e8412005-12-27 08:17:23506
Junio C Hamanofce7c7e2008-07-02 03:06:38507Read linkgit:githooks[5] for more details about each hook.
Junio C Hamano818f7d62006-03-26 01:49:30508
Junio C Hamano1a4e8412005-12-27 08:17:23509Higher level SCMs may provide and manage additional information in the
510`$GIT_DIR`.
511
512
513Terminology
514-----------
Junio C Hamanofce7c7e2008-07-02 03:06:38515Please see linkgit:gitglossary[7].
Junio C Hamano1a4e8412005-12-27 08:17:23516
517
518Environment Variables
519---------------------
520Various git commands use the following environment variables:
521
522The git Repository
523~~~~~~~~~~~~~~~~~~
524These environment variables apply to 'all' core git commands. Nb: it
525is worth noting that they may be used/overridden by SCMS sitting above
526git so take care if using Cogito etc.
527
528'GIT_INDEX_FILE'::
529This environment allows the specification of an alternate
530index file. If not specified, the default of `$GIT_DIR/index`
531is used.
532
533'GIT_OBJECT_DIRECTORY'::
534If the object storage directory is specified via this
535environment variable then the sha1 directories are created
536underneath - otherwise the default `$GIT_DIR/objects`
537directory is used.
538
539'GIT_ALTERNATE_OBJECT_DIRECTORIES'::
540Due to the immutable nature of git objects, old objects can be
541archived into shared, read-only directories. This variable
Junio C Hamano05bf9c52008-07-03 09:21:58542specifies a ":" separated (on Windows ";" separated) list
543of git object directories which can be used to search for git
544objects. New objects will not be written to these directories.
Junio C Hamano1a4e8412005-12-27 08:17:23545
546'GIT_DIR'::
547If the 'GIT_DIR' environment variable is set then it
548specifies a path to use instead of the default `.git`
549for the base of the repository.
550
Junio C Hamanod526ba92007-07-02 00:17:42551'GIT_WORK_TREE'::
552Set the path to the working tree. The value will not be
553used in combination with repositories found automatically in
554a .git directory (i.e. $GIT_DIR is not set).
555This can also be controlled by the '--work-tree' command line
556option and the core.worktree configuration variable.
557
Junio C Hamano15048272008-07-07 22:10:48558'GIT_CEILING_DIRECTORIES'::
559This should be a colon-separated list of absolute paths.
560If set, it is a list of directories that git should not chdir
561up into while looking for a repository directory.
562It will not exclude the current working directory or
563a GIT_DIR set on the command line or in the environment.
564(Useful for excluding slow-loading network directories.)
565
Junio C Hamanocc7636a2010-05-21 14:57:53566'GIT_DISCOVERY_ACROSS_FILESYSTEM'::
567When run in a directory that does not have ".git" repository
568directory, git tries to find such a directory in the parent
569directories to find the top of the working tree, but by default it
570does not cross filesystem boundaries. This environment variable
571can be set to true to tell git not to stop at filesystem
572boundaries. Like 'GIT_CEILING_DIRECTORIES', this will not affect
573an explicit repository directory set via 'GIT_DIR' or on the
574command line.
575
Junio C Hamano1a4e8412005-12-27 08:17:23576git Commits
577~~~~~~~~~~~
578'GIT_AUTHOR_NAME'::
579'GIT_AUTHOR_EMAIL'::
580'GIT_AUTHOR_DATE'::
581'GIT_COMMITTER_NAME'::
582'GIT_COMMITTER_EMAIL'::
Junio C Hamano469d60e2007-04-29 18:30:34583'GIT_COMMITTER_DATE'::
584'EMAIL'::
Junio C Hamano35738e82008-01-07 07:55:46585see linkgit:git-commit-tree[1]
Junio C Hamano1a4e8412005-12-27 08:17:23586
587git Diffs
588~~~~~~~~~
589'GIT_DIFF_OPTS'::
Junio C Hamano1c437122006-11-28 02:22:25590Only valid setting is "--unified=??" or "-u??" to set the
591number of context lines shown when a unified diff is created.
592This takes precedence over any "-U" or "--unified" option
593value passed on the git diff command line.
594
Junio C Hamano1a4e8412005-12-27 08:17:23595'GIT_EXTERNAL_DIFF'::
Junio C Hamano1c437122006-11-28 02:22:25596When the environment variable 'GIT_EXTERNAL_DIFF' is set, the
597program named by it is called, instead of the diff invocation
598described above. For a path that is added, removed, or modified,
599 'GIT_EXTERNAL_DIFF' is called with 7 parameters:
600
601path old-file old-hex old-mode new-file new-hex new-mode
602+
603where:
604
605<old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
606 contents of <old|new>,
607<old|new>-hex:: are the 40-hexdigit SHA1 hashes,
608<old|new>-mode:: are the octal representation of the file modes.
609
610+
611The file parameters can point at the user's working file
612(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
613when a new file is added), or a temporary file (e.g. `old-file` in the
614index). 'GIT_EXTERNAL_DIFF' should not worry about unlinking the
615temporary file --- it is removed when 'GIT_EXTERNAL_DIFF' exits.
616+
617For a path that is unmerged, 'GIT_EXTERNAL_DIFF' is called with 1
618parameter, <path>.
Junio C Hamano1a4e8412005-12-27 08:17:23619
Junio C Hamano7ccb9fd2006-07-15 01:38:40620other
621~~~~~
Junio C Hamano1e6e0062007-07-13 05:33:25622'GIT_MERGE_VERBOSITY'::
623A number controlling the amount of output shown by
624the recursive merge strategy. Overrides merge.verbosity.
Junio C Hamano35738e82008-01-07 07:55:46625See linkgit:git-merge[1]
Junio C Hamano1e6e0062007-07-13 05:33:25626
Junio C Hamano85e45fa2006-08-13 07:47:41627'GIT_PAGER'::
Junio C Hamanof6002a92007-07-20 10:28:22628This environment variable overrides `$PAGER`. If it is set
629to an empty string or to the value "cat", git will not launch
Junio C Hamano0551f6a2008-08-25 00:33:33630a pager. See also the `core.pager` option in
631linkgit:git-config[1].
Junio C Hamano85e45fa2006-08-13 07:47:41632
Junio C Hamano4cd1c0e2007-08-06 04:39:14633'GIT_SSH'::
Junio C Hamano1aa40d22010-01-21 17:46:43634If this environment variable is set then 'git fetch'
635and 'git push' will use this command instead
Junio C Hamanoba4b9282008-07-06 05:20:31636of 'ssh' when they need to connect to a remote system.
Junio C Hamanofce7c7e2008-07-02 03:06:38637The '$GIT_SSH' command will be given exactly two arguments:
Junio C Hamano4cd1c0e2007-08-06 04:39:14638the 'username@host' (or just 'host') from the URL and the
639shell command to execute on that remote system.
640+
641To pass options to the program that you want to list in GIT_SSH
642you will need to wrap the program and options into a shell script,
643then set GIT_SSH to refer to the shell script.
644+
645Usually it is easier to configure any desired options through your
646personal `.ssh/config` file. Please consult your ssh documentation
647for further details.
648
Junio C Hamano3fd7b262010-09-08 22:44:20649'GIT_ASKPASS'::
650If this environment variable is set, then git commands which need to
651acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
652will call this program with a suitable prompt as command line argument
653and read the password from its STDOUT. See also the 'core.askpass'
654option in linkgit:git-config[1].
655
Junio C Hamano401939f2007-07-01 06:34:30656'GIT_FLUSH'::
657If this environment variable is set to "1", then commands such
Junio C Hamano1aa40d22010-01-21 17:46:43658as 'git blame' (in incremental mode), 'git rev-list', 'git log',
659and 'git whatchanged' will force a flush of the output stream
Junio C Hamano401939f2007-07-01 06:34:30660after each commit-oriented record have been flushed. If this
661variable is set to "0", the output of these commands will be done
662using completely buffered I/O. If this environment variable is
663not set, git will choose buffered or record-oriented flushing
664based on whether stdout appears to be redirected to a file or not.
665
Junio C Hamano7ccb9fd2006-07-15 01:38:40666'GIT_TRACE'::
Junio C Hamanoef4b48b2006-09-04 10:08:34667If this variable is set to "1", "2" or "true" (comparison
668is case insensitive), git will print `trace:` messages on
Junio C Hamano7ccb9fd2006-07-15 01:38:40669stderr telling about alias expansion, built-in command
670execution and external command execution.
Junio C Hamanoef4b48b2006-09-04 10:08:34671If this variable is set to an integer value greater than 1
672and lower than 10 (strictly) then git will interpret this
673value as an open file descriptor and will try to write the
674trace messages into this file descriptor.
675Alternatively, if this variable is set to an absolute path
676(starting with a '/' character), git will interpret this
677as a file path and will try to write the trace messages
678into it.
Junio C Hamano7ccb9fd2006-07-15 01:38:40679
Junio C Hamano1a4e8412005-12-27 08:17:23680Discussion[[Discussion]]
681------------------------
Junio C Hamano597ffcf2007-09-17 17:33:15682
683More detail on the following is available from the
684link:user-manual.html#git-concepts[git concepts chapter of the
Junio C Hamanofce7c7e2008-07-02 03:06:38685user-manual] and linkgit:gitcore-tutorial[7].
Junio C Hamano597ffcf2007-09-17 17:33:15686
687A git project normally consists of a working directory with a ".git"
688subdirectory at the top level. The .git directory contains, among other
689things, a compressed object database representing the complete history
690of the project, an "index" file which links that history to the current
691contents of the working tree, and named pointers into that history such
692as tags and branch heads.
693
694The object database contains objects of three main types: blobs, which
695hold file data; trees, which point to blobs and other trees to build up
Junio C Hamanofe986052007-12-19 07:33:38696directory hierarchies; and commits, which each reference a single tree
Junio C Hamano597ffcf2007-09-17 17:33:15697and some number of parent commits.
698
699The commit, equivalent to what other systems call a "changeset" or
700"version", represents a step in the project's history, and each parent
701represents an immediately preceding step. Commits with more than one
702parent represent merges of independent lines of development.
703
704All objects are named by the SHA1 hash of their contents, normally
705written as a string of 40 hex digits. Such names are globally unique.
706The entire history leading up to a commit can be vouched for by signing
707just that commit. A fourth object type, the tag, is provided for this
708purpose.
709
710When first created, objects are stored in individual files, but for
711efficiency may later be compressed together into "pack files".
712
713Named pointers called refs mark interesting points in history. A ref
714may contain the SHA1 name of an object or the name of another ref. Refs
715with names beginning `ref/head/` contain the SHA1 name of the most
Junio C Hamanofe986052007-12-19 07:33:38716recent commit (or "head") of a branch under development. SHA1 names of
Junio C Hamano597ffcf2007-09-17 17:33:15717tags of interest are stored under `ref/tags/`. A special ref named
718`HEAD` contains the name of the currently checked-out branch.
719
720The index file is initialized with a list of all paths and, for each
721path, a blob object and a set of attributes. The blob object represents
722the contents of the file as of the head of the current branch. The
723attributes (last modified time, size, etc.) are taken from the
724corresponding file in the working tree. Subsequent changes to the
725working tree can be found by comparing these attributes. The index may
726be updated with new content, and new commits may be created from the
727content stored in the index.
728
729The index is also capable of storing multiple entries (called "stages")
730for a given pathname. These stages are used to hold the various
731unmerged version of a file when a merge is in progress.
Junio C Hamano1a4e8412005-12-27 08:17:23732
733Authors
734-------
735* git's founding father is Linus Torvalds <torvalds@osdl.org>.
Junio C Hamanodbb64592007-09-01 11:17:39736* The current git nurse is Junio C Hamano <gitster@pobox.com>.
Junio C Hamanoe0facb92007-12-05 10:59:48737* The git potty was written by Andreas Ericsson <ae@op5.se>.
Junio C Hamano1a4e8412005-12-27 08:17:23738* General upbringing is handled by the git-list <git@vger.kernel.org>.
739
740Documentation
741--------------
742The documentation for git suite was started by David Greaves
743<david@dgreaves.com>, and later enhanced greatly by the
744contributors on the git-list <git@vger.kernel.org>.
745
Junio C Hamanoa9788762010-08-03 15:15:54746Reporting Bugs
747--------------
748
749Report bugs to the Git mailing list <git@vger.kernel.org> where the
750development and maintenance is primarily done. You do not have to be
751subscribed to the list to send a message there.
752
Junio C Hamano9e1793f2008-06-02 07:31:16753SEE ALSO
754--------
755linkgit:gittutorial[7], linkgit:gittutorial-2[7],
Junio C Hamanoaf1987f2008-08-03 07:58:19756link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
Junio C Hamano9e1793f2008-06-02 07:31:16757linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
Junio C Hamano804b5212009-06-07 16:05:03758linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
759linkgit:gitworkflows[7]
Junio C Hamano9e1793f2008-06-02 07:31:16760
Junio C Hamano1a4e8412005-12-27 08:17:23761GIT
762---
Junio C Hamanof7c042d2008-06-06 22:50:53763Part of the linkgit:git[1] suite